  -------------------------------------------------------------------
			     FingerTec

                      OFIS SDK version 5.0 
			
			    Readme File
			   
			     September 2019
				
   --------------------------------------------------------------------
	   (c) 2019 FingerTec.com. All Rights Reserved. 


This document provides late-breaking or other information that supplements the FingerTec OFIS Client SDK documentation.


-------------------------
How to Use This Document
-------------------------

To view the Readme file on-screen in Windows Notepad, maximize the Notepad window. In the Format menu, click Word Wrap. To print the Readme file, open it in Notepad or another word processor, and then use the Print command on the File menu.


---------
CONTENTS
---------

1.   INSTALLATION

2.   COMPATIBILITY

3.   SYSTEM REQUIREMENTS

4.   KNOWN ISSUES
  
5.   SUPPORT AND FEEDBACK
 

----------------
1. INSTALLATION
----------------

You must have local administrator rights to install the following products on the supported operating systems:

FingerTec OFIS Scanner Driver 5.0
1- Insert OFIS Client CD in the CD-ROM drive.
2- Run "FingerTec OFIS Scanner Driver 5.0 Setup.exe" located in the "FingerTec_Ofis_Scanner" folder of the CD.
3- Follow the installation instructions.
4- Please reboot your machine after the installation.

FingerTec OFIS Client 5.0
1- Insert OFIS Client CD in the CD-ROM drive.
2- Run "OFIS Client 5.0 Setup.exe" located in the OFIS Client CD.
3- Follow the installation instructions.



-----------------
2. COMPATIBILITY
-----------------

FingerTec OFIS Scanner Driver 5.0 and FingerTec OFIS Client 5.0 software are compatible with all version of FingerTec OFIS Scanner including OFIS-X and OFIS-Y Scanner. Please uninstall the earlier version in order to install the latest installer.

FingerTec OFIS Client 5.0 support both 32 and 64 bit machine.


-----------------------
3. SYSTEM REQUIREMENTS
-----------------------

General System Requirements:

- X86-based processor or better
- CD-ROM drive
- Microsoft Windows XP Professional, Microsoft Windows Vista or Windows 7. (You must have administrative rights.)
- The minimum amount of RAM required to run FingerTec OFIS Client is 64MB.



------------------
4.   KNOWN ISSUES 
------------------

4.1    	Vista/Windows 7 write permission for Program Files folder
By default, users other than the system built-in administrator do not have write access to the Program File folder and its subfolders. Please use the administrator right to do the installation.


4.2    	Functions to initialize the fingerprint algorithm version used. Set it to either 9 or 10 to support your desired algorithm. By default, it is pre-set to algorithm 9.

	a) ofis.SetFPEngineVersion(algo:Integer):Integer;

	algo : 9 = version 9, 10 = version 10

	Example:

		ofis.SetFPEngineVersion(9);

4.3  	Ofis.PlayBeep(bool bValue) as Integer
	Functions to trigger the beep sound. Set it to true to turn on the beep and set it to false to turn off the beep sound. (For OFIS-Y only)

4.4 	Ofis.PlayGreenLight(bool bValue) as Integer
	Functions to turn on the green indication light. Set it to true to turn on the green light and set it to false to turn off the green light. (For OFIS-Y only)

4.5 	Ofis.PlayRedLight(bool bValue) as Integer
	Functions to turn on the red indication light. Set it to true to turn on the red light and set it to false to turn off the red light. (For OFIS-Y only)


4.6 	Ofis.CreateBuffer:Handle;
	example:
	FpHandle : Handle;
	OfisMain.InitSensor; //must init sensor before create buffer for the handle
	FpHandle := OfisMain.CreateBuffer;

4.7 	Ofis.AddRegTemplateToBuffer(FpHanlde:Handle,UserID:Integer,RegTemplate:String):Integer
	FpHandle: the handle created by CreateBuffer
	UserID:user id of the fingerprint template
	RegTemplate: user registered fingerprint template
	Result: 0:false, 1:true

4.8 	Ofis.IdentificationTemplateFromBuffer(FpHandle:Handle,VerTemplate:String):Integer
	FpHandle: the handle created by CreateBuffer
	VerTemplate: user fingerprint template
	Result: return UserID, else -1 for failed

4.9	Ofis.RemoveRegTemplateFromBuffer(FpHandle:Handle,UserID:Integer):Integer
	FpHandle: the handle created by CreateBuffer
	UserID:user id of the fingerprint template to be removed
	Result: 0:false, 1:true

4.10  	Ofis.FreeBuffer(FpHandle:Handle);
	FpHandle: the handle created by CreateBuffer

4.11	Ofis.SetTemplateFormat(0)  to set ANSI fingerprint template

4.12	Ofis.SetTemplateFormat(1)  to set ISO fingerprint template



------------------------
5. SUPPORT AND FEEDBACK
------------------------

If you have suggestions for future product releases or require technical support for your product, e-mail support@fingertec.com. In the subject line, type "FingerTec OFIS SDK support."

The FingerTec Web site, at http://www.fingertec.com, provides support for registered users as well.











